deployapplicationpackage - Ant Task |
Description
The Ant task deployapplicationpackage deploys an application package onto the specified Process Platform instance. The .cap file should be placed in the location <Cordys_HOME>\capcontent\packages folder. This task will not copy the .cap file. If you need to transfer a file, execute the ANT in-built copy or other equivalent task before executing this task.
Sample Usage
- Without input parameters
<deployapplicationpackage name="My Company Project" server="cin400599l" ldapRoot = "cn=cordys,cn=fp1cu7,o=myorg.com" />
- With input parameters
<deployapplicationpackage ldapRoot="cn=cordys,cn=fp1cu7,o=myorg.com" name="My Company Project" organization="myorg" revertOnFailure="false" server="cin400599l" userInputFile="E:My FolderCAPUserInput"/>
Parameters
Attribute |
Description |
Type |
Required |
|---|---|---|---|
name |
Name of the application package to be deployed. |
String |
Yes |
timeout |
Timeout value that will be used while loading the application package. Value should be specified in milliseconds. Default value is 30000 (ms). |
Integer |
No |
Refers to the location path of the XML file that contains the input to be passed to the application package while loading. |
String |
No |
|
ldapRoot |
LDAP root DN of Process Platform instance. |
String |
Yes |
server |
Name of the server on which the application package has to be deployed. Refers to the server on which Monitor service container is running. |
String |
Yes |
webserver |
Name of the server from which CAP can be downloaded (provided for distributed installation). Default value is the server attribute, which indicates that both the Monitor service container and Web server are configured on the same system. |
String |
No |
failOnError |
Accepts boolean value. Specify true if the build needs to be aborted when an exception occurs. Default value is true. |
Boolean |
No |
protocol |
Protocol used for downloading CAP from the server. Supported values are http and https. Default protocol is http. |
String |
No |
port |
Refers to the port number of the Web server. Default port number is 80 for http and 443 is https protocol. |
Integer |
No |
isUpgrade |
Accepts boolean value. Change the value to true if the application package needs to be upgraded. Default value is false. |
Boolean |
No |
version |
Refers to the version of the application package that needs to be deployed. By default, it will take the higher version of the application package. Specify this value only if a specific version of application package needs to be deployed. |
String |
No |
buildNumber |
Refers to the build number of the application package that needs to be deployed. This value is mandatory if version is provided. |
Double |
No |
revertOnFailure |
This flag reverts the application package to its previous state if an error occurs while deploying the application. Default value is true. |
Boolean |
No |
organization |
Refers to the name of the organization to which the package should be deployed. |
String |
No |
| acceptLicenseAgreements | Accepts boolean value. Specify true to accept the license agreement of the application package. | Boolean | No |
Note:
- The name parameter should not include
.capfile extension . The name should match 'Package Name' given in the CWS project package properties. - The default port depends upon the protocol value and the protocol value depends upon the default port.
- The buildNumber parameter will be ignored if version is empty.
- You need to follow additional steps to deploy an application package in an organization space. Refer to Managing Application Packages In Organization Space for detailed steps.
The possible assumptions of the values are stated in the below table:
If |
Then |
|---|---|
port = empty and protocol = empty |
port = 80, protocol = http |
port = 80, protocol = empty |
port = 80, protocol = http |
port = 443, protocol = empty |
port = 443, protocol = https |
port = empty, protocol = http |
port = 80, protocol = http |
port = empty, protocol = https |
port = 443, protocol = https |